[Java] Java注解

声明

本文转载自文章Java中的注解是如何工作的？，文章对注解讲解比较清楚，所以转载下来做个记录。

什么是注解

注解其实就是元数据，即一种描述数据的数据，所以，可以说注解就是源代码的元数据，比如，下面这段代码：

@Override
public String toString() {
  	return "This is a test";
}

上面的代码中，重写了toString()方法，并且使用了@Override注解，但是即使不使用@Override注解，程序也能够正常运行，事实上，@Override注解告诉编译器这个方法是一个重写方法（描述方法的元数据），如果父类中不存在该方法，编译器就会报错，提示该方法没有重写父类中的方法，如果不小心拼写错误，例如将toString()写成了toStrring()方法，而且如果没有使用@Override注解，那么程序依然能够编译运行，但运行结果和期望的不同。

Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由JSR-175标准选择用来描述元数据的一种工具。

为什么要引入注解

使用Annotation之前(甚至在使用之后)，XML被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现XML的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西，而不是像XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。如果你在Google中搜索“XML vs. annotations”，会看到许多关于这个问题的辩论。最有趣的是XML配置其实就是为了分离代码和配置而引入的。上述两种观点可能会让你很疑惑，两者观点似乎构成了一种循环，但各有利弊。下面我们通过一个例子来理解这两者的区别。

假如你想为应用设置很多的常量或参数，这种情况下，XML是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用Annotation会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

另一个很重要的因素是Annotation定义了一种标准的描述元数据的方式。在这之前，开发人员通常使用他们自己的方式定义元数据。例如，使用标记interfaces，注释，transient关键字等等。每个程序员按照自己的方式定义元数据，而不像Annotation这种标准的方式。

目前，许多框架将XML和Annotation两种方式结合使用，平衡两者之间的利弊。

Annotation是如何工作的？怎么编写自定义的Annotation？

编写Annotation非常简单，可以将Annotation的定义同接口的定义进行比较。我们来看两个例子：一个是标准的注解@Override，另一个是用户自定义注解@Todo。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
  
}

对于@Override注释你可能有些疑问，它什么都没做，那它是如何检查在父类中有一个同名的函数呢。当然，不要惊讶，我是逗你玩的。@Override注解的定义不仅仅只有这么一点代码。这部分内容很重要，我不得不再次重复：Annotations仅仅是元数据，和业务逻辑无关。理解起来有点困难，但就是这样。如果Annotations不包含业务逻辑，那么必须有人来实现这些逻辑。元数据的用户来做这个事情。Annotations仅仅提供它定义的属性(类/方法/包/域)的信息。Annotations的用户(同样是一些代码)来读取这些信息并实现必要的逻辑。

J2SE5.0版本在java.lang.annotation提供了四种元注解，专门注解其他的注解：

@Documented：一个简单的Annotations标记注解，表示是否将注解信息添加到Java文档中
@Retenion：定义该注解的生命周期
- RetentionPolicy.SOURCE：在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
- RetentionPolicy.CLASS：在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。
- RetentionPolicy.RUNTIME：始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
@Target：表示该注解用于什么地方。如果不明确指出，该注解可以放在任何地方。以下是一些可用的参数。需要说明的是：属性的注解是兼容的，如果你想给7个属性都添加注解，仅仅排除一个属性，那么你需要在定义target包含所有的属性。
- ElementType.TYPE：用于描述类、接口或enum声明
- ElementType.FIELD：用于描述实例变量
- ElementType.METHOD
- ElementType.PARAMETER
- ElementType.CONSTRUCTOR
- ElementType.LOCAL_VARIABLE
- ElementType.ANNOTATION_TYPE：另一个注释
- ElementType.PACKAGE ：用于记录java文件的package信息
@Inherited：定义该注释和子类的关系，可以被子类所继承

那么，注解的内部到底是如何定义的呢？Annotations只支持基本类型、String及枚举类型。注释中所有的属性被定义成方法，并允许提供默认值。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
  	public enum Priority {LOW, MEDIUM, HIGH}
  	public enum Status {STARTED, NOT_STARTED}
  	String author() default "Yash";
  	Priority priority() default Priority.LOW;
  	Status status() default Status.NOT_STARTED;
}

下面的例子演示了如何使用上面的注解：

@Todo(priority = Todo.Priority.MEDIUM, author = "Yashwant", status = Todo.Status.STARTED)
public void inCompleteMethod1() {
  
}

如果注解中只有一个属性，可以直接命名为”value”，使用时无需再标明属性名。

@interface Author {
  	String value();
}
@Author("Yashwant")
public void someMethod() {
  
}

到目前为止一切看起来都还不错。我们定义了自己的注解并将其应用在业务逻辑的方法上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。如果你熟悉反射代码，就会知道反射可以提供类名、方法和实例变量对象。所有这些对象都有getAnnotation()这个方法用来返回注解信息。我们需要把这个对象转换为我们自定义的注释(使用instanceOf()检查之后)，同时也可以调用自定义注释里面的方法。看看以下的实例代码，使用了上面的注解：

Class businessLoginClass = BusinessLogic.class;
for (Method method : businessLoginClass.getMethods()) {
  	Todo todoAnnotation = (Todo) method.getAnnotation(Todo.class);
  	if (todoAnnotation != null) {
      	System.out.println("Method Name: " + method.getName());
      	System.out.println("Author: " + todoAnnotation.author());
      	System.out.println("Priority: " + todoAnnotation.priority());
    	System.out.println("Status: " + todoAnnotation.status());
    }
}

[Java] Java注解

声明

什么是注解

为什么要引入注解

Annotation是如何工作的？怎么编写自定义的Annotation？

谢谢打赏